<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>glShaderBinary - OpenGL ES 3 Reference Pages</title>
    <link rel="stylesheet" type="text/css" href="opengl-man.css"/>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
    <script type="text/x-mathjax-config">
            MathJax.Hub.Config({
                MathML: {
                    extensions: ["content-mathml.js"]
                },
                tex2jax: {
                    inlineMath: [['$','$'], ['\\(','\\)']]
                }
            });
        </script>
    <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
  </head>
  <body>
    <header/>
    <div class="refentry" id="glShaderBinary">
      <div class="titlepage"/>
      <div class="refnamediv">
        <h2>Name</h2>
        <p>glShaderBinary — load pre-compiled shader binaries</p>
      </div>
      <div class="refsynopsisdiv">
        <h2>C Specification</h2>
        <div class="funcsynopsis">
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">void <strong class="fsfunc">glShaderBinary</strong>(</code>
              </td>
              <td>GLsizei <var class="pdparam">count</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>const GLuint *<var class="pdparam">shaders</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLenum <var class="pdparam">binaryFormat</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>const void *<var class="pdparam">binary</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLsizei <var class="pdparam">length</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
        </div>
      </div>
      <div class="refsect1" id="parameters">
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>count</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                Specifies the number of shader object handles contained in <em class="parameter"><code>shaders</code></em>.
            </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>shaders</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                Specifies the address of an array of shader handles into which to load pre-compiled shader binaries.
            </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>binaryFormat</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                Specifies the format of the shader binaries contained in <em class="parameter"><code>binary</code></em>.
            </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>binary</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                Specifies the address of an array of bytes containing pre-compiled binary shader code.
            </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>length</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                Specifies the length of the array whose address is given in <em class="parameter"><code>binary</code></em>.
            </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1" id="description">
        <h2>Description</h2>
        <p>
            <code class="function">glShaderBinary</code> loads pre-compiled shader binary code into the <em class="parameter"><code>count</code></em>
            shader objects whose handles are given in <em class="parameter"><code>shaders</code></em>. <em class="parameter"><code>binary</code></em>
            points to <em class="parameter"><code>length</code></em> bytes of binary shader code stored in client memory.
            <em class="parameter"><code>binaryFormat</code></em> specifies the format of the pre-compiled code.
        </p>
        <p>
            The binary image contained in <em class="parameter"><code>binary</code></em> will be decoded according to the extension
            specification defining the specified <em class="parameter"><code>binaryFormat</code></em> token. OpenGL ES
            does not define any specific binary formats, but it does provide a mechanism to obtain token
            vaues for such formats provided by such extensions.
        </p>
        <p>
            Depending on the types of the shader objects in <em class="parameter"><code>shaders</code></em>, <code class="function">glShaderBinary</code>
            will individually load binary vertex or fragment shaders, or load an executable binary that contains an optimized
            pair of vertex and fragment shaders stored in the same binary.
        </p>
      </div>
      <div class="refsect1" id="errors">
        <h2>Errors</h2>
        <p>
            <code class="constant">GL_INVALID_OPERATION</code> is generated if more than one of the handles in
            <em class="parameter"><code>shaders</code></em> refers to the same shader object.
        </p>
        <p>
            <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>binaryFormat</code></em> is not an
            accepted value.
        </p>
        <p>
            <code class="constant">GL_INVALID_VALUE</code> is generated if the data pointed to by <em class="parameter"><code>binary</code></em>
            does not match the format specified by <em class="parameter"><code>binaryFormat</code></em>.
        </p>
      </div>
      <div class="refsect1" id="associatedgets">
        <h2>Associated Gets</h2>
        <p>
            <a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with parameter <code class="constant">GL_NUM_SHADER_BINARY_FORMATS</code>.
        </p>
        <p>
            <a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with parameter <code class="constant">GL_SHADER_BINARY_FORMATS</code>.
        </p>
      </div>
      <div class="refsect1" id="versions">
        <h2>API Version Support</h2>
        <div class="informaltable">
          <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
            <colgroup>
              <col style="text-align: left; "/>
              <col style="text-align: center; " class="firstvers"/>
              <col style="text-align: center; " class="lastvers"/>
            </colgroup>
            <thead>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; ">
                 
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; " colspan="2">
                <span class="bold"><strong>OpenGL ES API Version</strong></span>
            </th>
              </tr>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>Function Name</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>2.0</strong></span>
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.0</strong></span>
            </th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td style="text-align: left; border-right: 2px solid ; ">glShaderBinary</td>
                <td style="text-align: center; border-right: 2px solid ; ">✔</td>
                <td style="text-align: center; ">✔</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1" id="seealso">
        <h2>See Also</h2>
        <p>
            <a class="citerefentry" href="glGetProgramiv.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetProgramiv</span></span></a>,
            <a class="citerefentry" href="glGetProgramBinary.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetProgramBinary</span></span></a>,
            <a class="citerefentry" href="glProgramBinary.xhtml"><span class="citerefentry"><span class="refentrytitle">glProgramBinary</span></span></a>
        </p>
      </div>
      <div class="refsect1" id="Copyright">
        <h2>Copyright</h2>
        <p>
            Copyright <span class="trademark"/>© 2010-2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p>
      </div>
    </div>
    <footer/>
  </body>
</html>
